Exchange (Area/Lane)

• AssignExchangeLane    1

• AssignExchangeLaneIfReady    1

• DetachConsoleFromLane (on-trouble)    1

• ClearTruckFromLane (on-trouble)    1

• ClearExchangeLaneIfAllDone    1

• DetachConsoleFromLane    1

• RejectOrderItemReserveAndDeliverCountExceeded    1

• MaintainAreaStats    1

• ClearTruckFromLane    1

• RecordLaneMission    1

• RejectExchangeLaneIfAlreadyOccupied    1

• RejectExchangeLaneInvalidForMoveKinds    1

• RejectNoExchangeArea    1

• RejectWrongExchangeArea    1

• RejectWrongExchangeLane    1

• SetDefaultExchangeArea    1

AssignExchangeLane

Description

The business task assigns an available exchange lane to the gate transaction at the ingate. Include this business task only for straddle operations and only at the last ingate stage, if more than one stage exists at the ingate. To assign exchange lanes to all the gate transactions for a truck visit, use either the truck visit level AssignExchangeLane business task or the AssignExchangeLaneIfReady (on page 1) business task.

Parameters

For the truck visit level AssignExchangeLane business task, you can use the assignmentSequence parameter (on page 1) to determine the sequence in which N4 assigns exchange lanes as follows:

• If null or blank, then N4 does not sequence the gate transactions. However, see note below about assignments defined in the Gate Lane form.

• ASCENDING: N4 sequences gate transactions in an ascending order. For example, N4 sequences exchange lanes 1-10 in an ascending order, such as 1, 3, 5, 7, 9, 2, 4, 6, 8, and 10.

• DESCENDING: N4 sequences gate transactions in a descending order. For example, N4 sequences exchange lanes 1-10 in a descending order, such as 10, 8, 6, 4, 2, 9, 7, 5, 3, and 1.

Before considering the assignmentSequence parameter, N4 takes into account any assignment priorities defined in the Gate Lane form (on page 1). In addition, N4 always tries to keep an empty exchange lane open between the assigned lanes when possible.

After sequencing the gate transactions, the AssignExchangeLane business task only assigns the first gate transactions belonging to the same exchange area to an exchange lane. N4 does not assign the remaining gate transaction(s) until the previously assigned gate transaction(s) have been processed in the exchange area. In addition, N4 does not include subsequent gate transactions that are to be performed in that same exchange area during a later return visit to the exchange area.

For example, if a truck visit has four gate transactions and the first and second transactions belong to exchange area A, the third to exchange area B, and the fourth to exchange area A. N4 only assigns the first and second gate transactions to a lane in exchange area A.

For all consecutive transactions belonging to the same exchange area, N4 assigns them all to the same exchange lane.

If the exchange area does not have any lanes defined, N4 does not assign the truck visit to an exchange lane and also does not return any errors.

Dependencies

• If the total TEU specified for a chassis profile exceeds the Max TEU limit in the exchange lane, then that exchange lane is not available.

• If you include the AssignExchangeLane business task, you cannot include the AssignExchangeLaneIfReady (on page 1) business task.

Timing

• For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• pre-stage: The business task is processed when the truck arrives at a gate stage and validates whether the truck is at the correct gate stage.

N4 processes this business task when creating a truck visit or when you click the Save Transaction button on the <GateStage> tab for the first gate transaction.

If any pre-stage business task fails at the first gate stage, N4 does not create a truck visit, and does not allow the user to send the truck to Trouble.

• on-arrival: The business task is processed when the truck arrives at the Exchange area. N4 processes this task when you click on the Confirm Arrival button at the bottom of the <GateStage> tab or process the notify-arrival API.

The Confirm Arrival button is available only if you have included an on-arrival business task in your truck visit configuration and the Stage Type of the gate stage is Out-gate Stage.

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

• validation: The business task is executed when a truck visit is created after successful execution of the pre-stage business tasks, but before the execution of the on-submit business tasks.

If a validation business task fails, N4 creates the truck visit and allows the user to send the truck visit to Trouble to be resolved later.

• on-trouble: The business task is executed when the truck is sent to Trouble.

• area-done: The business task is executed when N4 determines that all the gate transactions for the truck visit that were for this exchange area are done at the yard stage.

This gate work flow is executed when either of the following conditions is true:

N4 receives an area-done message through the API.

A clerk successfully Saves the last gate transaction for the yard stage at this exchange area and before the clerk clicks the Proceed to Next Stage button for the truck from a gate form.

As the final step in a process-truck API message when all transactions have been submitted.

Automatically from the transaction-level on-submit workflow if the stage is configured to check if all transactions are submitted for that stage. If the transaction-level on-submit workflow passes successfully, N4 checks whether this is the last transaction to be submitted during this visit to an exchange area, meaning that the next transaction, which has not yet been submitted at this stage, is for a different exchange area. If this is the last transaction submitted at the stage, then N4 considers it the last transaction at the exchange area. If the exchange area is null, either because it is a non-exchange area move in a terminal that has exchange areas or the terminal has no exchange areas, then null is treated like any other individual exchange area value.

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

AssignExchangeLaneIfReady

Description

The business task assigns an available exchange lane to the gate transactions that are ready at the current ingate stage. N4 assigns exchange lanes to gate transactions according to the sequencing of the gate transactions and the exchange area returned by XPS.

When assigning exchange lanes, N4 takes into account any assignment priorities defined in the Gate Lane form (on page 1). In addition, N4 always tries to keep an empty exchange lane open between the assigned lanes when possible.

The business task ignores gate transaction if:

• The gate transaction Status is COMPLETE.

• The gate transaction type is either Unknown or Through.

Parameters

You can use the following parameters (on page 1) to configure when gate transactions are ready for lane assignment and the assignment scheme N4 uses:

• executeIf:

• Always (default): Always, the transaction is always ready.

• IsLastBeforeYard: Only if the current gate stage is at or past the last stage before the yard.

• assignmentScheme:

• AssignAll (default): To assign an exchange lane, if possible, to all gate transactions for the truck visit.

• AssignNext: To assign an exchange lane, if possible, to all consecutive gate transactions belonging to the same exchange area. If one or more gate transactions belongs to a different exchange area, N4 only assigns the first gate transaction(s) for the same exchange area. N4 does not assign the remaining gate transaction(s) until the previously assigned gate transaction(s) have been processed in the exchange area. Use for gates with slot booths.

For example, if a truck visit has four gate transactions and the first and second transactions belong to exchange area A, the third to exchange area B, and the fourth to exchange area A. N4 only assigns the first and second gate transactions to a lane in exchange area A. Once these transactions have been processed in the exchange lane, N4 assigns the third transaction to a lane in exchange area B. Once the third transaction has been processed in the exchange lane, N4 assigns the fourth transaction to a lane in exchange area A.

For all consecutive transactions belonging to the same exchange area, N4 assigns them all to the same exchange lane.

Dependencies

If using the AssignExchangeLaneIfReady business task:

• You must include the SequenceTransactions (on page 1) business task to sequence the gate transactions.

• You must include the AssignExchangeLaneIfReady business task at every ingate stage, such as a slot booth, preceding an exchange area.

• You cannot include the AssignExchangeLane (on page 1) business task.

Timing

• For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• pre-stage: The business task is processed when the truck arrives at a gate stage and validates whether the truck is at the correct gate stage.

N4 processes this business task when creating a truck visit or when you click the Save Transaction button on the <GateStage> tab for the first gate transaction.

If any pre-stage business task fails at the first gate stage, N4 does not create a truck visit, and does not allow the user to send the truck to Trouble.

• on-arrival: The business task is processed when the truck arrives at the Exchange area. N4 processes this task when you click on the Confirm Arrival button at the bottom of the <GateStage> tab or process the notify-arrival API.

The Confirm Arrival button is available only if you have included an on-arrival business task in your truck visit configuration and the Stage Type of the gate stage is Out-gate Stage.

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

• validation: The business task is executed when a truck visit is created after successful execution of the pre-stage business tasks, but before the execution of the on-submit business tasks.

If a validation business task fails, N4 creates the truck visit and allows the user to send the truck visit to Trouble to be resolved later.

• on-trouble: The business task is executed when the truck is sent to Trouble.

• area-done: The business task is executed when N4 determines that all the gate transactions for the truck visit that were for this exchange area are done at the yard stage.

This gate work flow is executed when either of the following conditions is true:

N4 receives an area-done message through the API.

A clerk successfully Saves the last gate transaction for the yard stage at this exchange area and before the clerk clicks the Proceed to Next Stage button for the truck from a gate form.

As the final step in a process-truck API message when all transactions have been submitted.

Automatically from the transaction-level on-submit workflow if the stage is configured to check if all transactions are submitted for that stage. If the transaction-level on-submit workflow passes successfully, N4 checks whether this is the last transaction to be submitted during this visit to an exchange area, meaning that the next transaction, which has not yet been submitted at this stage, is for a different exchange area. If this is the last transaction submitted at the stage, then N4 considers it the last transaction at the exchange area. If the exchange area is null, either because it is a non-exchange area move in a terminal that has exchange areas or the terminal has no exchange areas, then null is treated like any other individual exchange area value.

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

DetachConsoleFromLane (on-trouble)

Description

The business task clears scanned data from the gate lane when a truck is sent to Trouble. It detaches the gate lane from the console so that the next gate transaction for a gate lane is not sent to the clerk who worked the previous gate transaction, unintentionally. This allows the same console to work a number of lanes.

Parameters

None

Dependencies

None

Timing

For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-trouble: The business task is executed when the truck is sent to Trouble.

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

ClearTruckFromLane (on-trouble)

Description

The business task clears scanned data from the gate lane when a truck is sent to Trouble if,

• The console selected by the user for performing gate operations is not associated with a gate lane (see Gate Lane form (on page 1)), or,

• The user did not select a console before performing the gate operation (see Select Console form (on page 1)).

Parameters

None

Dependencies

None

Timing

For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-trouble: The business task is executed when the truck is sent to Trouble.

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

ClearExchangeLaneIfAllDone

Description

Clears truck visit from the exchange lane if either of the following conditions is true:

• All gate transactions, other than the one being submitted, for the truck visit are COMPLETED, CANCELLED, or CLOSED.

• A gate transaction, other than the one being submitted, for the truck visit is at a gate stage prior to that which includes the ClearExchangeLaneIfAllDone business task.

Include this business task only for straddle operations.

Parameters

considerTranSeq: If you set it to TRUE, True, true, YES, Yes, yes, Y, or y N4 considers the transaction sequence number when clearing the exchange lane before assigning the truck to the lane at the gate stage.

Dependencies

None

Timing

For gate transactions, such as Receive Export or Receive Empty, N4 processes tasks when you click the Save Transaction button on the gate transaction section of the <GateStage> tab (on page 1).

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

DetachConsoleFromLane

Description

The business task clears scanned data from the gate lane and detaches the gate lane from the console On-submit so that the next gate transaction for a gate lane is not sent to the clerk who worked the previous gate transaction, unintentionally. This allows the same console to work a number of lanes.

Parameters

None

Dependencies

None

Timing

For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RejectOrderItemReserveAndDeliverCountExceeded

Description

The business task rejects a gate transaction if the total number of containers reserved or delivered against an EDO exceeds the Tally Limit.

If using this business task, you must use the Container Number Requested field at the ingate and the Container Number field at the outgate in your gate forms.

For EDO's, if the Dispatch Reserved is not set, N4 allows you to deliver unreserved containers if the total number of containers delivered and reserved against the EDO is lesser than the Tally Limit for the equipment order.

Parameters

ignoreDispatchReservedForEdo: When set to True, N4 ignores the value in the Dispatch Reserved field so that the business task RejectOrderItemReserveAndDeliverCountExceeded compares the [number of units reserved against the EDO + actual number of units actually delivered against the EDO] to the EDO Item Qty field regardless of the value in the Dispatch Reserved field.

Dependencies

None

Timing

• For gate transactions, such as Receive Export or Receive Empty, N4 processes tasks when you click the Save Transaction button on the gate transaction section of the <GateStage> tab (on page 1).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

MaintainAreaStats

This business task recomputes the number of trucks queued and trucks staged for each exchange area when a truck executes its configured timing point (on completion of the ingate, on completion of staging, and on completion of an area visit) or when a transaction is closed or canceled.

Functional Area

Gate

Execution Level

Truck Visit

Timing

• on-submit: When the truck is sent to next stage, but only after successful execution of the Validation tasks.

• area-done: When a truck is physically leaving the exchange area and has all its transactions for the exchange area of the current transaction submitted at the current stage.

Transaction Type(s)

Truck Visit IN, Truck Visit OUT

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

ClearTruckFromLane

Description

The business task clears scanned data from the gate lane On-submit if,

• The console selected by the user for performing gate operations is not associated with a gate lane (see Gate Lane form (on page 1)), or,

• The user did not select a console before performing the gate operation (see Select Console form (on page 1)).

Parameters

None

Dependencies

None

Timing

For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

RecordLaneMission

Populates the Mission field in the Gate Exchange Area Monitor view with a list of containers to be handled at that stage. It is a comma-separated list of equipment numbers prefixed by "-" for receivals and "+" for deliveries. For other transaction types, the prefix is "?".

When a truck is cleared from a lane, N4 clears the data in the Mission field for that lane. In addition, if the RecordLaneMission business task is included at a gate stage, a truck is in an exchange lane, and a user cancels a gate transaction for that truck, N4 updates the container list in the Mission field accordingly.

Functional Area

Gate

Execution Level

Truck Visit/on-arrival (at exchange lane) and Transaction/on-submit (on move completion)

Timing

• on-arrival: When posting the notify arrival request from clicking the confirm arrival button at the yard stage.

• on-submit: When the truck is sent to next stage, but only after successful execution of the Validation tasks.

Transaction Type(s)

Transaction: Dray Off (DE), Deliver Import (DI), Deliver Empty (DM), Receive Export (RE), Dray In (RI), Receive Empty (RM)

Truck Visit: Truck Visit OUT

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

None

Field(s)

None

RejectExchangeLaneIfAlreadyOccupied

ID Variations based on Timing

RejectExchangeLaneIfAlreadyOccupied: Validated only for the Gate UI workflow.

RejectExchangeLaneIfAlreadyOccupied (pre-stage): Validated only for the Gate API workflow.

Description

The business task rejects a gate transaction if the exchange lane is already occupied when a truck driver confirms arrival at the exchange lane. N4 displays the following error message that you can either fix or override:

Cannot confirm truck visit {0} to Exchange Lane {1} as lane is already occupied

If you click Override, N4 confirms both the trucks to the same exchange lane in XPS and overrides the Lane Monitor (on page 1) with the latest truck visit that confirms arrival at the exchange lane.

For an automated gate, the notify-arrival API triggers the business task. You can override the error by including the override-errors="true" attribute as shown in the example below:

<gate>

        <notify-arrival override-errors="true">

            <gate-id>FERG</gate-id>

            <stage-id>yard</stage-id>

            <exchange-area-id>FXG</exchange-area-id>

            <lane-id>FXG01</lane-id>

            <truck id="D2"/>

        </notify-arrival>

</gate>

Functional Area

Gate

Execution Level

Truck Visit

Transaction Type(s)

Truck Visit OUT

Timing

• For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• pre-stage: The business task is processed when the truck arrives at a gate stage and validates whether the truck is at the correct gate stage.

N4 processes this business task when creating a truck visit or when you click the Save Transaction button on the <GateStage> tab for the first gate transaction.

If any pre-stage business task fails at the first gate stage, N4 does not create a truck visit, and does not allow the user to send the truck to Trouble.

• on-arrival: The business task is processed when the truck arrives at the Exchange area. N4 processes this task when you click on the Confirm Arrival button at the bottom of the <GateStage> tab or process the notify-arrival API.

The Confirm Arrival button is available only if you have included an on-arrival business task in your truck visit configuration and the Stage Type of the gate stage is Out-gate Stage.

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

None

Related Business Task(s)

None

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

Field(s)

None

RejectExchangeLaneInvalidForMoveKinds

The business task rejects a gate transaction and displays an error if the exchange lane assigned to the truck visit does not allow a gate move (Gate Delivery or Gate Receival). However, for this business task to work as expected, you must ensure that at least one of the gate move kinds, either Gate Delivery or Gate Recieval, is assigned as the Allowed Move Kind for each of the exchange lanes.

N4 does not distinguish between a Gate Receival or Gate Delivery move kind and if at least one of these move kinds is assigned to an exchange lane, it allows you to use that exchange lane for both gate receival and delivery.

Functional Area

Gate

Execution Level

Truck Visit

Transaction Type(s)

Truck Visit IN and Truck Visit OUT

Timing

• on-arrival: The business task is processed when the truck arrives at the Exchange area. N4 processes this task when you click on the Confirm Arrival button at the bottom of the <GateStage> tab or process the notify-arrival API.

The Confirm Arrival button is available only if you have included an on-arrival business task in your truck visit configuration and the Stage Type of the gate stage is Out-gate Stage.

Client Type(s)

UI and Gate API

Parameters

None

Dependencies

You must ensure that at least one of the gate move kinds, either Gate Delivery or Gate Recieval, is assigned as the Allowed Move Kind for each of the exchange lanes.

Related Business Task(s)

None

Custom Code

Any custom code associated with the business task is executed following the execution of this business task and has no impact on it.

Field(s)

None

RejectNoExchangeArea

Rejects a gate transaction and sets the transaction status to TROUBLE if an exchange area is not specified.

RejectWrongExchangeArea

Rejects a gate transaction if the truck arrives at the wrong exchange area.

Functional Area

Gate

Execution Level

Transaction/Truck Visit

Transaction Type(s)

Truck Visit IN, Truck Visit OUT

Timing

• pre-stage: The business task is processed when the truck arrives at a gate stage and validates whether the truck is at the correct gate stage.

N4 processes this business task when creating a truck visit or when you click the Save Transaction button on the <GateStage> tab for the first gate transaction.

If any pre-stage business task fails at the first gate stage, N4 does not create a truck visit, and does not allow the user to send the truck to Trouble.

• on-arrival: The business task (for outbound truck visits only) generally activates work instructions (WIs) at the yard stage. N4 processes this task when you click on the Confirm Arrival button at the bottom of the <GateStage> tab.

The Confirm Arrival button is available only if you have included an on-arrival business task in your truck visit configuration and the Stage Type of the gate stage is Out-gate Stage.

Client Type(s)

UI and Gate API

Parameters

None

Related Business Task(s)

RejectWrongExchangeLane (on page 1) validates if a truck visit is in the correct exchange lane.

Custom Code

None

Field(s)

None

RejectWrongExchangeLane

Description

Rejects a gate transaction if the truck arrives at the wrong exchange lane. When this business task is included in the gate configuration, N4 validates a truck's position (that is its <lane-id>) against the appointed exchange lane at the time the gate operating system (GOS) calls the <notify-arrival> message. If the truck is not in the expected exchange lane, depending on the configured Lane Assignment Tolerance (see Exchange Area form (on page 1)), N4 returns an error.

This business task also relies on the value of the Appointed Exchange Lane field viewable in the Gate Transactions view.

Parameters

None

Dependencies

None

Timing

For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:

• pre-stage: N4 processes the business task RejectWrongExchangeLane (pre-stage) when you notify the arrival of the truck at the pre-stage either manually or by posting the API message with the exchange lane details. If the exchange lane is either incorrect or closed. N4 records an error message, but does not allow the user to send the truck to Trouble.

• on-arrival: The business task is processed when the truck arrives at the Exchange area. N4 processes this task when you click on the Confirm Arrival button at the bottom of the <GateStage> tab or process the notify-arrival API.

The Confirm Arrival button is available only if you have included an on-arrival business task in your truck visit configuration and the Stage Type of the gate stage is Out-gate Stage.

Related Business Task(s)

RejectWrongExcangeArea (on page 1) validates if a truck visit is in the correct exchange area (the exchange lane is validated by RejectWrongExchangeLane).

Custom Code

None

SetDefaultExchangeArea

Sets the exchange area to the value specified for the ExchangeAreaId parameter (on page 1) if the current value for the exchange area is null.

You can include this business task to resolve a Failed To Deck error resulting from a gate transaction not having an exchange area defined. This business task is used to set the default exchange area for the gate transaction to confirm the truck arrival at the yard stage.You can also override the default exchange area with a different value.